Book Object

The book object contains detailed information about a book in the library. This is used to retrieve and update book information.

Parameters

Name Type Description
ID string The unique identifier of the book which should be equal to the book name.
name string The name of the book.
songs array An array of songs expressed as either a list of song identifiers or song objects.
orderMethod string The method to use for sorting songs returned in the set. This can be one of the following values:
title
sort by song title
orderIndex
sorts by the order songs are placed in sets.
byline
sorts by songs artist using the byline property.
RANDOM()
sorts songs randomly.
added
sorts most recently added songs to the top of the list.
updated
sorts more recently updated songs to the top of the list.
favorite
sorts based on the favorite icon and its priority.
number
sorts using the song number.
lastPlayed
sorts songs by placing songs that were more recently played at the top of the list.
mostPopular
sorts songs by placing more popular songs to the top of the list.
orderDirection number Determines the sort direction. This can be zero to return songs in ascending order, or one to return songs in descending order.
useSeparateStyles number The date and time the set was created.

Example

{
    "ID": "Jam Group",
    "name": "Jam Group",
    "orderMethod": "added",
    "orderDirection": 0,
    "useSeparateStyles": 1
}